home *** CD-ROM | disk | FTP | other *** search
/ FishMarket 1.0 / FishMarket v1.0.iso / fishies / 526-550 / disk_530 / turbotitle / turbotitle.doc < prev    next >
Text File  |  1992-05-06  |  19KB  |  428 lines
  1.                                 TurboTitle
  2.                                    v0.80
  3.                                     By:
  4.                                Robert Jenks
  5.  
  6.  
  7.      TurboTitle was created for the purpose of subtitling Japanese
  8. Animation films and to create a standard Amiga subtitle format. Although
  9. created to subtitle Japanese Animation this program is perfectly suited
  10. for subtitling any foreign film.  It is also very usefull for subtitling
  11. for the hearing imparred.  TurboTitle version 0.80 is released as a
  12. shareware product and can be distributed as such in it's original 
  13. un-modified form.
  14.  
  15. The following files MUST acompany TurboTitle:
  16.  
  17. Root dir:
  18.     TurboTitle                              :    The main program.
  19.     TurboTitle.DOC                          :    This File.
  20.     Libs <directory>
  21.         req.library                         :    requester library
  22.     ForProgrammmers <directory>             :    requester docs, etc...
  23.         reqbase.i
  24.         reqbase.h
  25.         read.me
  26.         req.doc
  27.  
  28. All other files are optional, but suggested.        
  29.  
  30.      Please spread this program around as much as possible! The more people
  31. that use it, the more scripts that will be publicly available.
  32.  
  33.      The Shareware registration for this program is $15 and includes the
  34. following services:
  35.  
  36.      - If you send me a disk with a script(s) (timed or un-timed) that
  37.        you or a friend typed, I will send you the disk(s) back with the
  38.        latest version of TurboTitle and as many scripts as I can fit on
  39.        the disk. (as of  3/28/91 I have approx. 168 scripts)
  40.  
  41.      - When my BBS goes on-line you will be granted Un-Limited script
  42.        download time. And will also be able to download the latest 
  43.        version of TurboTitle and many other fine shareware products.
  44.  
  45.      Please send you registration fee of $15 and your Name, Comapny,
  46. Address, and Phone to:
  47.             
  48.                               Robert Jenks
  49.                               1322 20th Court
  50.                               Oceano, Ca 93445
  51.  
  52.  
  53. You can reach me for technical support on:
  54.             
  55.               BIX as 'rjenks'
  56.               The Blue Star BBS as 'Robert Jenks' (214) 234-1647
  57.               Animation Fido-Net Echo as 'Robert Jenks'
  58.               
  59. ------------------------------------------------------------------------
  60. User Manual
  61. ========================================================================
  62.  
  63.      The folowing is an abridged version of the final documentation that
  64. will be released with version 1.0.  This is written for users familiar
  65. with basic Subtitling and CLI experience.
  66.  
  67. Steps to install TurboTitle on a Workbench disk:
  68.  
  69.     1. Load up workbench 1.3 or higher.
  70.  
  71.     2. Make a copy of your workbench 1.3 or 2.0 disk 1.
  72.  
  73.     3. Modify the contents to resemble the following:
  74.  
  75.     ---------------------------------------------------------------
  76.      System (dir)
  77.             .info                            CLI
  78.             DiskCopy                         FastMemFirst
  79.             Format                           
  80.      c (dir)
  81.             AddBuffers                       Assign
  82.             Avail                            Binddrivers
  83.             Break                            CD
  84.             Copy                             Delete
  85.             Dir                              DiskChange
  86.             Echo                             Ed
  87.             EndCLI                           Execute
  88.             Failat                           FF
  89.             Info                             Install
  90.             Join                             LoadWB
  91.             Makedir                          More
  92.             Mount                            NewShell
  93.             Path                             Prompt
  94.             Quit                             Relabel
  95.             Rename                           Resident
  96.             Run                              SetPatch
  97.             Type                             
  98.      Prefs (dir)
  99.             .info                            Preferences
  100.             Preferences.info                 
  101.      l (dir)
  102.             Aux-Handler                      Disk-Validator
  103.             Newcon-Handler                   Pipe-Handler
  104.             Port-Handler                     Ram-Handler
  105.             Shell-Seg                        Speak-Handler
  106.      devs (dir)
  107.           keymaps (dir)
  108.                  usa1                             
  109.           printers (dir)
  110.                  generic                          
  111.           clipboards (dir)
  112.             MountList                        ramdrive.device
  113.             system-configuration             
  114.      s (dir)
  115.             Shell-Startup                    Startup-Sequence
  116.      fonts (dir)
  117.           helvetica (dir)
  118.                  .info                            29.4C
  119.                  36.4C                            
  120.             helvetica.font                   
  121.      libs (dir)
  122.             diskfont.library                 icon.library
  123.             info.library                     req.library
  124.             version.library                  
  125.      T (dir)
  126.        .info                            ColorText
  127.        ColorText.info                   Disk.info
  128.        Prefs.info                       Shell
  129.        Shell.info                       TurboTitle
  130.        TurboTitle.DOC                   TurboTitle.DOC.info
  131.        TurboTitle.info                  
  132.     ---------------------------------------------------------------
  133.  
  134.     4. Use a standard text-editor such as ED, CED, etc... to add these
  135. lines to your s:startup-sequence file:
  136.  
  137.     -----------------------S:Startup-Sequence----------------------
  138.  
  139.     assign TT: df0: ;The location of TurboTitle executable files.
  140.     assign TTS: ram: ;The location of script files.
  141.     assign SPELL: df0:spell ;Included for future versions.
  142.  
  143.     ---------------------------------------------------------------
  144.  
  145.     5. Boot off this disk with your genlock connected to a VCR, LD and 
  146. a TV set (Not a monitor!) Then adjust your workbench preferences so that
  147. the Worbench screen is centered on your screen (LEFT, RIGHT, TOP, and 
  148. BOTTOM!) Make sure you have a video signal going into your genlock before
  149. doing this though and use a TV set not a Monitor so that you can be sure
  150. that the screen will be fully visible on any standard TV set.
  151.  
  152.     6. TurboTitle can be executed from either Workbench 1.3+ or from 
  153. CLI or Shell windows.  From workbench double-click on the TurboTitle
  154. icon or from CLI type 'run TT:TurboTitle'.
  155.  
  156.  
  157. ------------------------------------------------------------------------
  158. Steps for subtitling a film:
  159. ========================================================================
  160.  
  161.     1. Type or convert an ascii text file to the TurboTitle ASCII format.
  162. (described latter under the FILE/LOAD ASCII menu function). This can be 
  163. accomplished in any standard ascii text editor such as: Ed, CED, Memacs,
  164. TxEd, etc... WordPerfect users must save the files as standard ascii 
  165. format, NOT WP format!
  166.  
  167.     2. If you have ColorText run it now. Alternatly you may wish to run
  168. it in your startup-sequence.
  169.  
  170.     3. Run TurboTitle in Workbench 1.3 or higher. You can do this by
  171. double-clicking on the Icon in workbench or by typing in a CLI or shell
  172. window; 'run TT:TurboTitle'
  173.  
  174.     4. Load the ASCII script with the FILE/LOAD ASCII menu option.
  175.  
  176.     5. Then save the file with the FILE/SAVE menu option. Make sure you
  177. change the name to .TTS though.
  178.  
  179.     6. Use the PREFS/FONT/VIEW to load your prefered subtitling font.
  180. (Helvetica 29 & 36 are supplied, but need ColorText to be used.) 
  181.  
  182.     7. Then use the SCRIPT/VIEW menu function to make sure all of the
  183. pages are 1, 2, or 3 lines long. Not 4 lines! Make a note of all the
  184. pages than need correcting. If the output is just 'ERROR' for any 
  185. page then the page was more than 4 lines long or a word on that page
  186. would not fit on one line.
  187.  
  188.     8. FILE/QUIT TurboTitle. 
  189.  
  190.     9. Then use your text-editor to edit the .TTS script file.  Make
  191. the needed changes to the script from step 7.
  192.  
  193.     10. Repeat steps 6 thru 9 until the script is the way you want it.
  194.  
  195.     11. Re-Load TurboTitle and load the script. Then use the SCRIPT/TIME
  196. menu funtion to time the file. Remember: It is not critical to time it
  197. perfectly, just try to be consistantly off. Then you can use the 
  198. SHIFT/TIME SHIFT/ALL function to adjust the script to your sync point.
  199. I find that I usualy am off by about 2/10 of a second on my initial
  200. timing run.
  201.  
  202.     12. Then I ususaly will use the SCRIPT/PLAY function and record the
  203. results to a temporary tape. Then manualy adjust the timing on any lines
  204. that are off by wathing the temporary tape and editing the script at the
  205. same time.
  206.  
  207.     13. Repeat any of the steps above as necessary and be sure to save
  208. your work as you go. It is also handy to save to a different file name
  209. often so you can always revert back to an older version. (read the
  210. description of the FILE/LOAD SCRIPT function for a description of file
  211. standard script file naming) 
  212.  
  213.  
  214.  
  215. ------------------------------------------------------------------------
  216. Menu Functions:
  217. ========================================================================
  218.  
  219.      Below is a brief summary of the menu functions.  Please notify me 
  220. if you expirience any problem in using my program or any bugs in the 
  221. software. I would also be glad to hear any suggestions or coments about
  222. the program. Remember: Support the developer and he will suport you!
  223.  
  224. ------------------------------------------------------------------------
  225. Menu Comands:
  226.  
  227.   FILE menu-------------------------------------------------------------
  228.  
  229.      LOAD SCRIPT - This Option loads script files in in the following
  230.            format: (every line in the file must look like this)
  231.            
  232.            H:MM:SS.DD,H:MM:SS.DD,NAME<space or TAB>QUOTE
  233.         
  234.            H     = Hours (range 0-9)
  235.            MM    = Minutes (range 0-59)
  236.            SS    = Seconds (range 0-59)
  237.            DD    = Hundredth of a second (range 0-99)
  238.            NAME  = Name of the Character who is speaking
  239.                    (Cannot contain any spaces)
  240.                    (if no name is used put a tilde(~) for the NAME)
  241.                    (The name can not be longer that 10 characters)
  242.            QUOTE = What the character is saying
  243.                    (cannot be longer than 200 characters)
  244.  
  245.            The Puctuation must be exact. Any misused or misplaced
  246.            punctuation will cause an error. Be sure to use a .(period)
  247.            between the SS and the DD and one space or a tab character
  248.            between the NAME and the QUOTE. 
  249.  
  250.            The first time is used for the Starting time and the second
  251.            is for the ending. The NAME will not be printed when playing
  252.            the script, but will only be used for ease in timing.
  253.  
  254.            ---------------------------------------------------------------
  255.            The standard file name format for TurboTitle scripts is:
  256.  
  257.            Name[side][-version].TTS
  258.  
  259.            [side] is a letter representing the side of the media source
  260.            and is only used when the media being subtitled is a laser disk
  261.            or other source with more than one side.  The first side should
  262.            be 'A' the second 'B' and so forth.  
  263.  
  264.            [-version] is a numeral representing the timing version of the
  265.            script. The untimed version should be '-0', and the final timing
  266.            should be the highest version number.
  267.  
  268.            An example would be: 
  269.  
  270.            VenusWarsA-0.TTS
  271.  
  272.            Venus Wars is the movie, the side is A, it is Un-Timed and the
  273.            script format is TTS (standard TurboTitle format). 
  274.  
  275.            Please use this naming convention for all of your scripts for
  276.            standardization.
  277.  
  278.      LOAD TJP SCRIPT - This option was included for compatability for  
  279.            with another subtitling program I have, until now, been using.
  280.            It will convert all timing for you and should run with the 
  281.            same or better acuracy.
  282.  
  283.            Scripts loaded with this option are not guaranteed to run on
  284.            time due to inherent flaws in the TJP-Subtitling program.  
  285.          
  286.            (The TJP program was good, but it's main flaw was that it was
  287.            written in BASIC. BASIC was not able to keep up with the titles
  288.            on many of the films I subtitled with it and so they ran behind.
  289.            Sometimes just time-shifting them will correct the problem, but
  290.            not always.)
  291.  
  292.            There is no standard file extension for this, but I would 
  293.            suggest that you use .TJP
  294.  
  295.      LOAD ASCII SCRIPT - This option is usefull when loading a script for
  296.            the first time. It is suggested that all scripts be typed in
  297.            the following format and read in with this option.
  298.  
  299.            NAME QUOTE
  300.  
  301.            This is exactly like the TTS format except that there are no
  302.            start and end time fields.  You can use either a space or a 
  303.            tab character in between the fields.  If there is no name use
  304.            a tilde '~' for the NAME field.
  305.  
  306.            Files typed this way should be named in the folowing format:
  307.  
  308.            Name[side].ASCII
  309.  
  310.            [side] is a letter representing the side of the media source
  311.            and is only used when the media being subtitled is a laser disk
  312.            or other source with more than one side.  The first side should
  313.            be 'A' the second 'B' and so forth.
  314.  
  315.            An example would be:
  316.  
  317.            VenusWarsA.ASCII
  318.  
  319.            The movie is Venus Wars, the side is A, and file type is ASCII. 
  320.  
  321.      SAVE SCRIPT - This option saves the current file as a .TTS file
  322.            that can be re-loaded with the LOAD SCRIPT option.
  323.  
  324.      ABOUT - Display's the shareware notice for this program.
  325.  
  326.      QUIT - Self explanitory.  MAKE SURE YOU HAVE SAVED YOUR WORK BEFORE
  327.            USING THIS OPTION. 
  328.  
  329.   SCRIPT menu-----------------------------------------------------------
  330.  
  331.      Special Note - it is always a good idea to save before using a 
  332.            SCRIPT menu option. If the program is going to crash it will
  333.            do it here! Also, there will be a short pause after you
  334.            select one of these options. This is normal and sould not
  335.            take more that a few seconds.
  336.  
  337.      VIEW - Displays the entire script so that you can scan for posible
  338.            errors and long pages. A page refers to one line in the text
  339.            file and a set of 1-4 lines on the view-screen. At any time
  340.            you can stop the display by pressing 'q'.
  341.  
  342.            Use this function after every LOAD opion to be sure that the 
  343.            file was loaded corectly and entirely. If there were any
  344.            errors the display will proably be garbled after completion
  345.            of this option. If so, quit without saving and manualy edit
  346.            the script with an editor (e.g. ED) and correct the problem.
  347.  
  348.            A faster way to make sure the file was loaded properly is to
  349.            check the total pages on the status line and compare it to
  350.            the number of lines in the text file.
  351.  
  352.      TIME - This option allows you to edit the start and end timeing on
  353.            all of the pages withing your script in real-time.
  354.  
  355.            With a gen-loc attached to your computer, hook up your source
  356.            media to the input on the gen-loc and cue it to the begining.
  357.            Then hook the output to a monitor or TV to watch the titles.
  358.            Next select the TIME option. It will blank the screen and 
  359.            a reqester will appear.  Find a spot in the beging or before
  360.            the Movie starts and we will call that the Sync point. Re-cue
  361.            the movie to the begining and wait for the sync pont. At the
  362.            exact moment of the sync pont click on the SYNC gadget in the
  363.            requester. You should see a small line of text at the bottom of
  364.            your screen this is the NAME and QUOTE of the next page. When
  365.            the time comes for the first QUOTE to be on the screen press
  366.            the [RETURN] key. this will display the page and print the
  367.            NAME and QUOTE of the page after it on the bottom of the screen.
  368.  
  369.            You can press:
  370.  
  371.            'q' to quit
  372.            [RETURN] to display the next page
  373.            [SPACE BAR] to clear the current page
  374.  
  375.            An important fact to remember is that this option saves the 
  376.            time when you press the RETURN or SPACE BAR key, NOT when
  377.            the title appears. (Although there should not be much
  378.            of a difference between the two)
  379.  
  380.      PLAY - Works exactly like the TIME function but does not display the
  381.            next page at the bottom of the screen and will not alow you to
  382.            modify the timing.
  383.  
  384.            You can press 'q' to quit 
  385.  
  386.    PREFS menu------------------------------------------------------------
  387.  
  388.      WORKBENCH - Toggle menu funtion that allows you to close workbench
  389.            to free up more memory. This MAY allow TurboTitle to run with
  390.            only 512k and very short scripts.  Caution: I have noticed
  391.            that this sometimes has ill effects under WorkBench 1.3, but
  392.            always works perfectly in 2.0.  If you have problems PLEASE
  393.            let me know.
  394.  
  395.      INTERLACE - Toggle menu function that allows you to edit your script
  396.            in interlaced or non-interlaced mode. This option does not 
  397.            effect the VIEW screen.
  398.  
  399.      LINE SPACING - Allows you to adjust the space between the lines on
  400.            the view page.
  401.  
  402.      TEXT MODE - Allows you to set the TEXT mode to either display the
  403.            font on the background color or set a specific background
  404.            color. Usefull if you don't have ColorText.
  405.  
  406.      FONT - Selects the font you wish to subtitle in. Run ColorText for
  407.            multiple color fonts if using workbench 1.3 or lower.
  408.  
  409.      PALETTE - Modifies the current palette for the VIEW or EDIT screen.
  410.  
  411.      SAVE PREFS - saves your current prefrences.
  412.  
  413.    SHIFT menu------------------------------------------------------------
  414.  
  415.      TIME SHIFT - Shifts the start and end times by a specific value.
  416.  
  417.            It is usualy best to time shift by 0:00:00.20 SpeedUp after the
  418.            first use of the TIME option.
  419.  
  420.      RAMP TIME - Allows you to do a very complex time shift where the
  421.            beggining of the film needs to be delayed and the end needs to
  422.            be sped up or visa-versa.  Usefull for converting scripts that
  423.            have been timed out on different machines.  Not currently
  424.            available, probably next version :-).
  425.  
  426.      AUTO SHUT-OFF - Computes the optimum time a title should be on for 
  427.            and adjusts the End Time accordingly. 
  428.